home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / XmVaCreateSimpleOptionMenu.z / XmVaCreateSimpleOptionMenu
Encoding:
Text File  |  2002-10-03  |  11.8 KB  |  265 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu - A RowColumn widget convenience
  10.           creation function
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////RRRRoooowwwwCCCCoooolllluuuummmmnnnn....hhhh>>>>
  14.  
  15.           WWWWiiiiddddggggeeeetttt XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu ((((_p_a_r_e_n_t, _n_a_m_e, _o_p_t_i_o_n__l_a_b_e_l,
  16.                     _o_p_t_i_o_n__m_n_e_m_o_n_i_c, _b_u_t_t_o_n__s_e_t, _c_a_l_l_b_a_c_k, _a_r_g...))))
  17.                WWWWiiiiddddggggeeeetttt    _p_a_r_e_n_t;;;;
  18.                SSSSttttrrrriiiinnnngggg    _n_a_m_e;;;;
  19.                XXXXmmmmSSSSttttrrrriiiinnnngggg  _o_p_t_i_o_n__l_a_b_e_l;;;;
  20.                KKKKeeeeyyyySSSSyyyymmmm    _o_p_t_i_o_n__m_n_e_m_o_n_i_c;;;;
  21.                iiiinnnntttt       _b_u_t_t_o_n__s_e_t;;;;
  22.                XXXXttttCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc_c_a_l_l_b_a_c_k;;;;
  23.  
  24.  
  25.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  26.           This page documents version 1.2 of the Motif library.
  27.  
  28.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  29.           XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu creates an instance of a
  30.           RowColumn widget of type XXXXmmmmMMMMEEEENNNNUUUU____OOOOPPPPTTTTIIIIOOOONNNN and returns the
  31.           associated widget ID.  This routine uses the ANSI C
  32.           variable-length argument list (varargs) calling convention.
  33.  
  34.           This routine creates an OptionMenu and its Pulldown submenu
  35.           containing PushButtonGadget or CascadeButtonGadget children.
  36.           The name of each button is button__n, where _n is an integer
  37.           from 0 to one minus the number of buttons in the menu.  The
  38.           name of each separator is separator__n, where _n is an integer
  39.           from 0 to one minus the number of separators in the menu.
  40.           Buttons and separators are named and created in the order in
  41.           which they are specified in the variable portion of the
  42.           argument list.
  43.  
  44.  
  45.           _p_a_r_e_n_t Specifies the parent widget ID
  46.  
  47.           _n_a_m_e   Specifies the name of the created widget
  48.  
  49.           _o_p_t_i_o_n__l_a_b_e_l
  50.                  Specifies the label string to be used on the left
  51.                  side of the OptionMenu.
  52.  
  53.           _o_p_t_i_o_n__m_n_e_m_o_n_i_c
  54.                  Specifies a keysym for a key that, when pressed by
  55.                  the user, posts the associated Pulldown MenuPane.
  56.  
  57.           _b_u_t_t_o_n__s_e_t
  58.                  Specifies which PushButtonGadget is initially set.
  59.                  The value is the integer _n that corresponds to the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                  _nth PushButtonGadget specified in the variable
  75.                  portion of the argument list.  Only a
  76.                  PushButtonGadget can be set, and only
  77.                  PushButtonGadgets are counted in determining the
  78.                  integer _n.  The first PushButtonGadget is number 0.
  79.  
  80.           _c_a_l_l_b_a_c_k
  81.                  Specifies a callback procedure to be called when a
  82.                  button is activated.  This callback function is added
  83.                  to each button after creation as the button's
  84.                  XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk.  The callback function is called
  85.                  when a button is activated, and the button number is
  86.                  returned in the _c_l_i_e_n_t__d_a_t_a field.
  87.  
  88.  
  89.           The variable portion of the argument list consists of groups
  90.           of arguments.  The first argument in each group is a
  91.           constant or a string and determines which arguments follow
  92.           in that group.  The last argument in the list must be NULL.
  93.           Following are the possible first arguments in each group of
  94.           varargs:
  95.  
  96.  
  97.           XXXXmmmmVVVVaaaaPPPPUUUUSSSSHHHHBBBBUUUUTTTTTTTTOOOONNNN
  98.                  This is followed by four additional arguments.  The
  99.                  set specifies one button in the OptionMenu's Pulldown
  100.                  submenu and some of its resource values.  The button
  101.                  created is a PushButtonGadget.  Following are the
  102.                  additional four arguments, in this order:
  103.  
  104.  
  105.                  _l_a_b_e_l   The label string, of type XmString.
  106.  
  107.                  _m_n_e_m_o_n_i_c
  108.                          The mnemonic, of type KeySym.
  109.  
  110.                  _a_c_c_e_l_e_r_a_t_o_r
  111.                          The accelerator, of type String.
  112.  
  113.                  _a_c_c_e_l_e_r_a_t_o_r__t_e_x_t
  114.                          The accelerator text, of type XmString.
  115.  
  116.  
  117.           XXXXmmmmVVVVaaaaSSSSEEEEPPPPAAAARRRRAAAATTTTOOOORRRR
  118.                  This is followed by no additional arguments.  It
  119.                  specifies one separator in the OptionMenu's Pulldown
  120.                  submenu.
  121.  
  122.           XXXXmmmmVVVVaaaaDDDDOOOOUUUUBBBBLLLLEEEE____SSSSEEEEPPPPAAAARRRRAAAATTTTOOOORRRR
  123.                  This is followed by no additional arguments.  It
  124.                  specifies one separator in the OptionMenu's Pulldown
  125.                  submenu.  The separator type is XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____LLLLIIIINNNNEEEE.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           _r_e_s_o_u_r_c_e__n_a_m_e
  141.                  This is followed by one additional argument, the
  142.                  value of the resource, of type XtArgVal.  The pair
  143.                  specifies a resource and its value for the Pulldown
  144.                  submenu.
  145.  
  146.           XXXXttttVVVVaaaaTTTTyyyyppppeeeeddddAAAArrrrgggg
  147.                  This is followed by four additional arguments.  The
  148.                  set specifies a resource and its value for the
  149.                  Pulldown submenu.  A resource type conversion is
  150.                  performed if necessary.  Following are the additional
  151.                  four arguments, in this order:
  152.  
  153.  
  154.                  _n_a_m_e    The resource name, of type String.
  155.  
  156.                  _t_y_p_e    The type of the resource value supplied, of
  157.                          type String.
  158.  
  159.                  _v_a_l_u_e   The resource value (or a pointer to the
  160.                          resource value, depending on the type and
  161.                          size of the value), of type XtArgVal.
  162.  
  163.                  _s_i_z_e    The size of the resource value in bytes, of
  164.                          type int.
  165.  
  166.  
  167.           XXXXttttVVVVaaaaNNNNeeeesssstttteeeeddddLLLLiiiisssstttt
  168.                  This is followed by one additional argument of type
  169.                  XtVarArgsList.  This argument is a nested list of
  170.                  varargs returned by XXXXttttVVVVaaaaCCCCrrrreeeeaaaatttteeeeAAAArrrrggggssssLLLLiiiisssstttt.
  171.  
  172.  
  173.           The user can specify resources in a resource file for the
  174.           automatically created widgets and gadgets of an OptionMenu.
  175.           The following list identifies the names of these widgets (or
  176.           gadgets) and the associated OptionMenu areas.
  177.  
  178.  
  179.             +o
  180.  
  181.             +o  Option Menu Label Gadget-"OptionLabel"
  182.  
  183.             +o  Option Menu Cascade Button-"OptionButton"
  184.  
  185.  
  186.           For more information on variable-length argument lists, see
  187.           the X Toolkit Intrinsics documentation.
  188.  
  189.           A number of resources exist specifically for use with this
  190.           and other simple menu creation routines.  For a complete
  191.           definition of RowColumn and its associated resources, see
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmVVVVVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn((((3333XXXX)))).
  207.  
  208.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  209.           Returns the RowColumn widget ID.
  210.  
  211.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  212.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeeRRRRoooowwwwCCCCoooolllluuuummmmnnnn((((3333XXXX)))),
  213.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX)))), and XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn((((3333XXXX)))).
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.